-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release sentinel 2023 06 01 preview #24362
Conversation
…w/2023-05-01-preview to version 2023-06-01-preview
Co-authored-by: Oleh Formaniuk <[email protected]>
Hi, @nazang Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
AlertRules.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
AlertRules.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
AutomationRules.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
AutomationRules.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
BillingStatistics.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Bookmarks.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
Bookmarks.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ContentPackages.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ContentProductPackages.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ContentProductTemplates.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ContentTemplates.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Enrichment.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Entities.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
EntityQueries.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
EntityQueryTemplates.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
FileImports.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Hunts.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Incidents.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
Incidents.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Metadata.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
Metadata.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
OfficeConsents.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
OnboardingStates.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
OnboardingStates.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Recommendations.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
SecurityMLAnalyticsSettings.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
SecurityMLAnalyticsSettings.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Settings.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
SourceControls.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ThreatIntelligence.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
ThreatIntelligence.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
TriggeredAnalyticsRuleRuns.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
Watchlists.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
Watchlists.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
WorkspaceManagerAssignments.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
WorkspaceManagerConfigurations.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
WorkspaceManagerGroups.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
WorkspaceManagerMembers.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
AlertTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
AlertTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ContentCommonTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
EntityTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
EntityTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
IncidentTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
IncidentTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
RelationTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
ThreatIntelligenceTypes.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
dataConnectors.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
operations.json | 2023-06-01-preview(ecb6eb0) | 2023-02-01(main) |
operations.json | 2023-06-01-preview(ecb6eb0) | 2023-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 13 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 13 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.3) | new version | base version |
---|---|---|
package-preview-2023-06 | package-preview-2023-06(ecb6eb0) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
The resource SourceControl does not have a corresponding delete operation. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/SourceControls.json#L343 |
RPC-Delete-V1-05 |
The following errors/warnings exist before current PR submission:
Only 13 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AlertRules.json#L178 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Actions_CreateOrUpdate' Request Model: 'parameters[6].schema' Response Model: 'responses[200].schema' Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AlertRules.json#L338 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AlertRules.json#L372 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AutomationRules.json#L93 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AutomationRules.json#L148 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AutomationRules.json#L154 |
SyncPostReturn |
204 response for a synchronous POST operation must not have a response schema specified. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/AutomationRules.json#L281 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/Bookmarks.json#L157 |
ResourceNameRestriction |
The resource name parameter 'relationName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/Bookmarks.json#L331 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/Bookmarks.json#L412 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/Bookmarks.json#L566 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/dataConnectors.json#L253 |
SyncPostReturn |
200 response for a synchronous POST operation must have a response schema specified. Location: Microsoft.SecurityInsights/preview/2023-06-01-preview/dataConnectors.json#L340 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 174 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-06; Prod region: Deployed
Test run on region: westeurope; Operation coverage: total: 167, untested: 0, failed: 164, passed: 3
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 13 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_ListBookmarks |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_ListEntities |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_CreateTeam |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: teamName Source: request OperationId: Incidents_CreateTeam |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: teamDescription Source: request OperationId: Incidents_CreateTeam |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: groupIds Source: request OperationId: Incidents_CreateTeam |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: memberIds Source: request OperationId: Incidents_CreateTeam |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_RunPlaybook |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Incidents_ListAlerts |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.OperationalInsights/workspaces/workspacexm0qq' under resource group 'apiTest-WBFHMC-24362' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Hunts_CreateOrUpdate |
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Hi @nazang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Hi, @nazang, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
Breaking changes previously reviewed and approved in #23121 |
@keryul, is it possible to get it reviewed and merged by today? We are 2 weeks behind the target dates, and have been blocked days on this merge. All the change in this PR has already been reviewed and approved. |
@keryul, could you merge this please? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
* Adds base for updating Microsoft.SecurityInsights from version preview/2023-05-01-preview to version 2023-06-01-preview * Updates readme * Updates API version in new specs and examples * Sentinel - SourceControls 2023-06-01-preview (Azure#24151) Co-authored-by: Oleh Formaniuk <[email protected]> * Fix creds scan error, remove real object id from sample file. (Azure#24410) --------- Co-authored-by: Oleh Formaniuk <[email protected]> Co-authored-by: Oleh Formaniuk <[email protected]>
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
[ X] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.